/**
 * Copyright 2011 Honeywell Federal Manufacturing & Technologies, LLC. This material was produced under U.S. Government
 * contract DE-ACO4-01AL66850, Honeywell Federal Manufacturing & Technologies, LLC, (FM&T) with the U. S. Department of
 * Energy for the operation of the Kansas City Plant . The U.S. Government has rights to use, reproduce, and distribute
 * this software.  NEITHER THE GOVERNMENT NOR Honeywell Federal Manufacturing & Technologies, LLC, MAKES ANY WARRANTY,
 * EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE.  If software is modified to produce
 * derivative works, such modified software should be clearly marked, so as not to confuse it with the version available
 * from FM&T.
 *
 * Additionally, this program is free software; you can redistribute it and/or modify it under the terms of the GNU
 * General Public License Version 3 published by the Free Software Foundation. Accordingly, this program is distributed in
 * the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this library.
 * If not, see http://www.gnu.org/licenses/.
 */
package org.braintrain.services;

import com.kcp.ko.authentication.domain.AuthenticatableUser;
import org.apache.tapestry.util.exception.ExceptionDescription;
import org.springframework.mail.MailException;

import javax.mail.MessagingException;


/**
 * Message service interface
 * @author Robert Engelhardt
 */
public interface MessageService {
	
	/**
	 * Send a message to a recipient
	 * 
	 * @param recipient the recipient
	 * @param originator the message originator
	 * @param messageSubject the subject of the message
	 * @param messageBody the body of the message to be sent to the recipient
	 * @param attachmentFileName the file name of the attachment 
	 * @param attachment the attachment to include with the message, null for no attachment
	 * 
	 * @throws MailException
	 * @throws MessagingException 
	 */
	void sendMessage(AuthenticatableUser recipient, String originator, String messageSubject, String messageBody, String attachmentFileName, byte[] attachment ) throws MailException, MessagingException;
	
	/**
	 * Send an exception message
	 * 
	 * @param descriptions the exception encountered
	 * @param userName of the user that encountered the message
	 */
	void sendException( ExceptionDescription[] descriptions, String userName) throws Exception;
}
